home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sspr.z / sspr
Encoding:
Text File  |  2002-10-03  |  16.0 KB  |  331 lines

  1.  
  2.  
  3.  
  4. SSSSSSSSPPPPRRRR((((3333SSSS))))                                                              SSSSSSSSPPPPRRRR((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SSSSSSSSPPPPRRRR, DDDDSSSSPPPPRRRR, CCCCSSSSPPPPRRRR, ZZZZSSSSPPPPRRRR - Performs symmetric rank 1 update of a real or
  10.      complex symmetric packed matrix
  11.  
  12. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.      Single precision
  14.  
  15.           Fortran:
  16.                CCCCAAAALLLLLLLL SSSSSSSSPPPPRRRR ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _x,,,, _i_n_c_x,,,, _a_p))))
  17.  
  18.           C/C++:
  19.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  20.                vvvvooooiiiidddd sssssssspppprrrr ((((cccchhhhaaaarrrr _u_p_l_o,,,, ffffllllooooaaaatttt *_n,,,, ffffllllooooaaaatttt _a_l_p_h_a,,,, iiiinnnntttt _x,,,, iiiinnnntttt _i_n_c_x,,,,
  21.                ffffllllooooaaaatttt *_a_p))));;;;
  22.  
  23.      Double precision
  24.  
  25.           Fortran:
  26.                CCCCAAAALLLLLLLL DDDDSSSSPPPPRRRR ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _x,,,, _i_n_c_x,,,, _a_p))))
  27.  
  28.           C/C++:
  29.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  30.                vvvvooooiiiidddd sssssssspppprrrr ((((cccchhhhaaaarrrr _u_p_l_o,,,, ddddoooouuuubbbblllleeee *_n,,,, ddddoooouuuubbbblllleeee _a_l_p_h_a,,,, iiiinnnntttt _x,,,, iiiinnnntttt _i_n_c_x,,,,
  31.                ddddoooouuuubbbblllleeee *_a_p))));;;;
  32.  
  33.      Single precision complex
  34.  
  35.           Fortran:
  36.                CCCCAAAALLLLLLLL CCCCSSSSPPPPRRRR ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _x,,,, _i_n_c_x,,,, _a_p))))
  37.  
  38.           C/C++:
  39.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  40.                vvvvooooiiiidddd ccccsssspppprrrr ((((cccchhhhaaaarrrr _u_p_l_o,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_n,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a_l_p_h_a,,,, iiiinnnntttt
  41.                _x,,,, iiiinnnntttt _i_n_c_x,,,, ssssccccssssllll____ccccoooommmmpppplllleeeexxxx *_a_p))));;;;
  42.  
  43.           C++ STL:
  44.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  45.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  46.                vvvvooooiiiidddd ccccsssspppprrrr ((((cccchhhhaaaarrrr _u_p_l_o,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_n,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a_l_p_h_a,,,,
  47.                iiiinnnntttt _x,,,, iiiinnnntttt _i_n_c_x,,,, ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>> *_a_p))));;;;
  48.  
  49.      Double precision complex
  50.  
  51.           Fortran:
  52.                CCCCAAAALLLLLLLL ZZZZSSSSPPPPRRRR ((((_u_p_l_o,,,, _n,,,, _a_l_p_h_a,,,, _x,,,, _i_n_c_x,,,, _a_p))))
  53.  
  54.           C/C++:
  55.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  56.                vvvvooooiiiidddd zzzzsssspppprrrr ((((cccchhhhaaaarrrr _u_p_l_o,,,, iiiinnnntttt _n,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a_l_p_h_a,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  57.                *_x,,,, iiiinnnntttt _i_n_c_x,,,, ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx *_a_p))));;;;
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSSSSSPPPPRRRR((((3333SSSS))))                                                              SSSSSSSSPPPPRRRR((((3333SSSS))))
  71.  
  72.  
  73.  
  74.           C++ STL:
  75.                ####iiiinnnncccclllluuuuddddeeee <<<<ccccoooommmmpppplllleeeexxxx....hhhh>>>>
  76.                ####iiiinnnncccclllluuuuddddeeee <<<<ssssccccssssllll____bbbbllllaaaassss....hhhh>>>>
  77.                vvvvooooiiiidddd zzzzsssspppprrrr ((((cccchhhhaaaarrrr _u_p_l_o,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_n,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>
  78.                *_a_l_p_h_a,,,, iiiinnnntttt _x,,,, iiiinnnntttt _i_n_c_x,,,, ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>> *_a_p))));;;;
  79.  
  80. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  81.      These routines are part of the SCSL Scientific Library and can be loaded
  82.      using either the ----llllssssccccssss or the ----llllssssccccssss____mmmmpppp option.  The ----llllssssccccssss____mmmmpppp option
  83.      directs the linker to use the multi-processor version of the library.
  84.  
  85.      When linking to SCSL with ----llllssssccccssss or ----llllssssccccssss____mmmmpppp, the default integer size is
  86.      4 bytes (32 bits). Another version of SCSL is available in which integers
  87.      are 8 bytes (64 bits).  This version allows the user access to larger
  88.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  89.      by using the ----llllssssccccssss____iiii8888 option or the ----llllssssccccssss____iiii8888____mmmmpppp option. A program may use
  90.      only one of the two versions; 4-byte integer and 8-byte integer library
  91.      calls cannot be mixed.
  92.  
  93.      The C and C++ prototypes shown above are appropriate for the 4-byte
  94.      integer version of SCSL. When using the 8-byte integer version, the
  95.      variables of type iiiinnnntttt become lllloooonnnngggg lllloooonnnngggg and the <<<<ssssccccssssllll____bbbbllllaaaassss____iiii8888....hhhh>>>> header
  96.      file should be included.
  97.  
  98. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  99.      These routines perform the following symmetric rank 1 operation:
  100.  
  101.           _A <- _a_l_p_h_a _x_x_T + _A
  102.  
  103.      where _x_T  is the transpose of _x, _a_l_p_h_a is a real or complex scalar, _x is
  104.      an _n-element vector, and _A is an _n-by-_n symmetric packed matrix.
  105.  
  106.      See the NOTES section of this man page for information about the
  107.      interpretation of the data types described in the following arguments.
  108.  
  109.      These routines have the following arguments:
  110.  
  111.      _u_p_l_o      Character.  (input)
  112.                Specifies whether the upper or lower triangular part of matrix
  113.                _A is packed into the array argument _a_p, as follows:
  114.  
  115.                _u_p_l_o= 'U' or 'u':  the upper triangular part of _A is being
  116.                supplied in the argument _a_p.
  117.                _u_p_l_o= 'L' or 'l':  the lower triangular part of _A is being
  118.                supplied in the argument _a_p.
  119.  
  120.                For C/C++, a pointer to this character is passed.
  121.  
  122.      _n         Integer.  (input)
  123.                Specifies the order of matrix _A.  _n >= 0.
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSSSSSPPPPRRRR((((3333SSSS))))                                                              SSSSSSSSPPPPRRRR((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      _a_l_p_h_a     Scalar alpha.  (input)
  141.                SSSSSSSSPPPPRRRR: Single precision.
  142.                DDDDSSSSPPPPRRRR: Double precision.
  143.                CCCCSSSSPPPPRRRR: Single precision complex.
  144.                ZZZZSSSSPPPPRRRR: Double precision complex.
  145.  
  146.                For C/C++, a pointer to this scalar is passed when alpha is
  147.                complex; otherwise, alpha is passed by value.
  148.  
  149.      _x         Array of dimension 1+(_n-1) * |_i_n_c_x|.  (input)
  150.                SSSSSSSSPPPPRRRR: Single precision array.
  151.                DDDDSSSSPPPPRRRR: Double precision array.
  152.                CCCCSSSSPPPPRRRR: Single precision complex array.
  153.                ZZZZSSSSPPPPRRRR: Double precision complex array.
  154.                Contains vector _x.
  155.  
  156.      _i_n_c_x      Integer.  (input)
  157.                Specifies the increment for the elements of _x.  _i_n_c_x must not
  158.                be 0.
  159.  
  160.      _a_p        Array of dimension (_n(_n+1))/2 .  (input and output)
  161.                SSSSSSSSPPPPRRRR: Single precision array.
  162.                DDDDSSSSPPPPRRRR: Double precision array.
  163.                CCCCSSSSPPPPRRRR: Single precision complex array.
  164.                ZZZZSSSSPPPPRRRR: Double precision complex array.
  165.  
  166.                Before entry with _u_p_l_o = 'U' or 'u', array _a_p must contain the
  167.                upper triangular part of the symmetric matrix packed
  168.                sequentially, column-by-column, so that _a_p(1) contains _A(1,1),
  169.                _a_p(2) contains _A(1,2), _a_p(3) contains _A(2,2), and so on.  On
  170.                exit, the upper triangular part of the updated matrix
  171.                overwrites array _a_p.
  172.  
  173.                Before entry with _u_p_l_o = 'L' or 'l', array _a_p must contain the
  174.                lower triangular part of the symmetric matrix packed
  175.                sequentially, column-by-column, so that _a_p(1) contains _A(1,1),
  176.                _a_p(2) contains _A(2,1), _a_p(3) contains _A(3,1), and so on.  On
  177.                exit, the lower triangular part of the updated matrix
  178.                overwrites array _a_p.
  179.  
  180. NNNNOOOOTTTTEEEESSSS
  181.      SSSSSSSSPPPPRRRR/DDDDSSSSPPPPRRRR is a Level 2 Basic Linear Algebra Subprogram (Level 2 BLAS).
  182.      CCCCSSSSPPPPRRRR/ZZZZSSSSPPPPRRRR is an extension to Level 2 BLAS.
  183.  
  184.      When working backward (_i_n_c_x < 0), each routine starts at the end of the
  185.      vector and moves backward, as follows:
  186.  
  187.           _x(1-_i_n_c_x * (_n-1)), _x(1-_i_n_c_x * (_n-2)), ..., _x(1)
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. SSSSSSSSPPPPRRRR((((3333SSSS))))                                                              SSSSSSSSPPPPRRRR((((3333SSSS))))
  203.  
  204.  
  205.  
  206.    DDDDaaaattttaaaa TTTTyyyyppppeeeessss
  207.      The following data types are described in this documentation:
  208.  
  209.           TTTTeeeerrrrmmmm UUUUsssseeeedddd                     DDDDaaaattttaaaa ttttyyyyppppeeee
  210.  
  211.      Fortran:
  212.  
  213.           Array dimensioned _n           xxxx((((nnnn))))
  214.  
  215.           Character                     CCCCHHHHAAAARRRRAAAACCCCTTTTEEEERRRR
  216.  
  217.           Integer                       IIIINNNNTTTTEEEEGGGGEEEERRRR (IIIINNNNTTTTEEEEGGGGEEEERRRR****8888 for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  218.  
  219.           Single precision              RRRREEEEAAAALLLL
  220.  
  221.           Double precision              DDDDOOOOUUUUBBBBLLLLEEEE PPPPRRRREEEECCCCIIIISSSSIIIIOOOONNNN
  222.  
  223.           Single precision complex      CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  224.  
  225.           Double precision complex      DDDDOOOOUUUUBBBBLLLLEEEE CCCCOOOOMMMMPPPPLLLLEEEEXXXX
  226.  
  227.      C/C++:
  228.  
  229.           Array dimensioned _n           xxxx[[[[_n]]]]
  230.  
  231.           Character                     cccchhhhaaaarrrr
  232.  
  233.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  234.  
  235.           Single precision              ffffllllooooaaaatttt
  236.  
  237.           Double precision              ddddoooouuuubbbblllleeee
  238.  
  239.           Single precision complex      ssssccccssssllll____ccccoooommmmpppplllleeeexxxx
  240.  
  241.           Double precision complex      ssssccccssssllll____zzzzoooommmmpppplllleeeexxxx
  242.  
  243.      C++ STL:
  244.  
  245.           Array dimensioned _n           xxxx[[[[_n]]]]
  246.  
  247.           Character                     cccchhhhaaaarrrr
  248.  
  249.           Integer                       iiiinnnntttt (lllloooonnnngggg lllloooonnnngggg for ----llllssssccccssss____iiii8888[[[[____mmmmpppp]]]])
  250.  
  251.           Single precision              ffffllllooooaaaatttt
  252.  
  253.           Double precision              ddddoooouuuubbbblllleeee
  254.  
  255.           Single precision complex      ccccoooommmmpppplllleeeexxxx<<<<ffffllllooooaaaatttt>>>>
  256.  
  257.  
  258.  
  259.  
  260.  
  261.                                                                         PPPPaaaaggggeeee 4444
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. SSSSSSSSPPPPRRRR((((3333SSSS))))                                                              SSSSSSSSPPPPRRRR((((3333SSSS))))
  269.  
  270.  
  271.  
  272.           Double precision complex      ccccoooommmmpppplllleeeexxxx<<<<ddddoooouuuubbbblllleeee>>>>
  273.  
  274.      Note that you can explicitly declare multidimensional C/C++ arrays
  275.      provided that the array dimensions are swapped with respect to the
  276.      Fortran declaration (e.g., xxxx[[[[nnnn]]]][[[[mmmm]]]] in C/C++ versus xxxx((((mmmm,,,,nnnn)))) in Fortran).
  277.      To avoid a compiler type mismatch error in C++ (or a compiler warning
  278.      message in C), however, the array should be cast to a pointer of the
  279.      appropriate type when passed as an argument to a SCSL routine.
  280.  
  281. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  282.      IIIINNNNTTTTRRRROOOO____SSSSCCCCSSSSLLLL(3S), IIIINNNNTTTTRRRROOOO____BBBBLLLLAAAASSSS2222(3S), CCCCHHHHPPPPRRRR(3S)
  283.  
  284.      IIIINNNNTTTTRRRROOOO____CCCCBBBBLLLLAAAASSSS(3S) for information about using the C interface to Fortran 77
  285.      Basic Linear Algebra Subprograms (legacy BLAS) set forth by the Basic
  286.      Linear Algebra Subprograms Technical Forum.
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.                                                                         PPPPaaaaggggeeee 5555
  325.  
  326.  
  327.  
  328.  
  329.  
  330.  
  331.